Update Reservation

Updates an existing reservation.

HTTP Request

PUT https://dev.calry.app/api/v2/vrs/reservations

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN
workspaceId	YOUR_WORKSPACE_ID
integrationAccountId	YOUR_INTEGRATION_ACCOUNT_ID

Request Body

The request body should be a JSON object containing the following fields:

Field	Type	Description
reservationId	string/number	Required. Reservation ID of the stay.
arrivalDate	string	Optional. Date of arrival in YYYY-MM-DD format.
departureDate	string	Optional. Date of arrival in YYYY-MM-DD format.
guest	object
guest.name	string	Optional. Full name of the guest.
guest.firstName	string	Optional. First name of the guest.
guest.lastName	string	Optional. Last name of the guest.
guest.email	string	Optional. Email address of the guest.
guest.phone	string/number	Optional. Phone number of the guest.
guest.address	object
guest.address.line1	string	Optional. Address line 1 of the guest.
guest.address.line2	string	Optional. Address line 2 of the guest.
guest.address.postalCode	string	Optional. Postal code of the guest's address.
guest.address.city	string	Optional. City of the guest's address.
guest.address.state	string	Optional. State of the guest's address.
guest.address.country	string	Optional. Country of the guest's address.
numberOfGuests	number	Optional. Total number of guests.
numberOfAdults	number	Optional. Number of adults among the guests.
numberOfChildren	number	Optional. Number of children among the guests.
numberOfInfants	number	Optional. Number of infants among the guests.
numberOfPets	number	Optional. Number of pets accompanying the guests.
status	string	Optional. Status of the reservation.
notes	string	Optional. Additional notes regarding the stay.
codes.accessCode	string[]	Optional. Lock-box code/Access code of the property for this reservation.
comments	string	Optional. Additional comments regarding the stay.
customFields	object	Optional. Custom fields for the reservation.

Note:

• For cancelling a reservation, only include the reservationId and status = "CANCELLED" in the request body.

Custom Fields

Custom fields can be added to the reservation object. The custom fields object should contain the following fields:

Field	Type	Description
name	string	Name of the custom field.
value	string	Value of the custom field.
id	string	Optional. ID of the custom field.

Example Request

curl --location --request PUT 'https://dev.calry.app/api/v2/vrs/reservations' \
--header 'integrationAccountId: 73847ee7-33d9-441d-a87c-ed09d99a14a9' \
--header 'workspaceId: 2210620e-76d9-4b40-a11b-76d9fd3e6e1c' \
--header 'Authorization: Bearer eyJraWQiOiJzLTY1NWJlZGUyLTg1ZDAtNDc3Ny1hNmU0LTMzNzhhZDA1YWYzMyIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjhmZmMyZDhkLWQ3NzQtNGI3OS1iZjJiLWQ5MWJmNDMyYmZmMCIsIndvcmtzcGFjZUlkIjoiMjIxMDYyMGUtNzZkOS00YjQwLWExMWItNzZkOWZkM2U2ZTFjIiwibmFtZSI6InNhZnNkc2RmYSIsInNvdXJjZSI6Im1pY3Jvc2VydmljZSIsImlhdCI6MTcxMjM0NTMwOCwiZXhwIjoxMjkzMzQ2NjUyMH0.iZy1C3u46eqBWs5NvfItCOz8of-PFCt2CL6U_GJZTpNxInmGuLD4BjUyeKiiyOgLtPZgMSGurmocZPie5rqQF-gpvCgChIsn19ZmQGuTPYSN0iHEn8A9afL3yPatTLN2YdqiGU0PMk-XL1XW2drNxASAG0gDCbuz5hH18zclkHPPIIBPJmmhrkR76r0nmKFPjWNhxmEZXng1fHVi8ojx4ZA40WvV2MmOu95BueprZP645jsvWYfnl76cmmxXivTHKGDmiu-g0i8-JlYKUBLz6ZqiwgQv4DmluBXuI5bqPrkuwsiIZTT0ZQaWKLASENuH-lMbkECTCqHjRdJoHZSkag' \
--header 'Content-Type: application/json' \
--data '{
    "reservationId": "53541199",
    "arrivalDate": "2024-03-10",
    "departureDate": "2024-03-12",
    "numberOfGuests": 3,
    "numberOfAdults": 2,
    "numberOfChildren": 1,
    "numberOfInfants": 0,
    "codes": {
        "accessCode": [
        "3256"
        ]
    }
    "customFields": {
        "name": "newCode",
        "value": "qeww121123"
    }
}'

Example Response

{
    "data":
    {
        success: true,
    }
}